📝 (doc) [NO-ISSUE]: Update documentation after feedbacks #483
+33
−27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
mbertin-ledger
force-pushed
the
chore/no-issue-doc_feedbacks
branch
from
72f70c0
to
a9f930b
Compare
valpinkman
reviewed
Nov 8, 2024
apps/docs/pages/docs/_meta.json
Outdated
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "docs": "Ledger Device Management Kits", | |||
| "explanations": "Explanations", | |||
| "begginers": "Begginer's guide", | |||
| "beginers": "Beginer's guide", | |||
valpinkman
reviewed
Nov 8, 2024
apps/docs/pages/docs/docs.mdx
Outdated
| @@ -18,7 +18,7 @@ You can follow the migration guidelines [here](./migrations/) | |||
|
|
|||
| ## Glossary | |||
|
|
|||
| Through all the documentation we will use some acronyme that you can find the following description : | |||
| Throughout all the documentation we will use several acronymes that you can find the following description : | |||
valpinkman
reviewed
Nov 8, 2024
|
|
||
| - `connected`: The device is connected. | ||
| - `locked`: The device is locked. | ||
| - `locked`: The device is locked. User needs to unlock it. |
There was a problem hiding this comment.
It's weird to add "User needs to unlock it", either you add something like "User needs to unlock it to perform operations with the DMK" (or something like that),or we remove that sentence
valpinkman
reviewed
Nov 8, 2024
|
|
||
| ## Current Problems | ||
|
|
||
| Ledger JS libraries where initially made for **Ledger Live** applications. As Ledger Live is a pretty old project (> 7 years), | ||
| we have inevitably a big technical debt. Moreover time make that some part of the logic are today hard to understand and to maintain. | ||
|
|
||
| Moreover, some device behavior are not well handled by the libraries. For example, opening an application on the device will cause unexpected disconnection. | ||
| Another feedback we have learnt from partners (software wallets) is that we have a lack of simplicity in the libraries, it require low level knowledge to use them (ex: APDU concept). | ||
| Some device behavior are not well handled by the libraries, for example opening an application on the device will cause unexpected disconnection. |
There was a problem hiding this comment.
"not well" => "not correctly"
valpinkman
requested changes
Nov 8, 2024
mbertin-ledger
force-pushed
the
chore/no-issue-doc_feedbacks
branch
from
a9f930b
to
6ca8903
Compare
mbertin-ledger
force-pushed
the
chore/no-issue-doc_feedbacks
branch
from
6ca8903
to
66580e2
Compare
smartine-ledger
approved these changes
Nov 8, 2024
valpinkman
approved these changes
Nov 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Update documentation after reviews
❓ Context
Dev portal documentation
✅ Checklist
Pull Requests must pass CI checks and undergo code review. Set the PR as Draft if it is not yet ready for review.
🧐 Checklist for the PR Reviewers